<!DOCTYPE html>

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RaxanDataSanitizer - Raxan User Guide</title>
    <link href="../raxan/ui/css/master.css" rel="stylesheet" type="text/css" />
    <!--[if lt IE 8]> <link rel="stylesheet" href="../raxan/ui/css/master.ie.css" type="text/css"><![endif]-->
    <link href="../raxan/ui/css/default/theme.css" rel="stylesheet" type="text/css" />
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        <!--
        hljs.initHighlightingOnLoad('javascript','html','php','css');
        //-->
    </script>
    <!--[if lt IE 7]>
        <style type="text/css"> form input.textbox { height: 26px; }</style>
    <![endif]-->
</head>

<body>
    <div class="container">
        <div id="header" class="rax-header-pal rax-metalic">
            <h2 class="ltm bottom c14">Raxan User Guide</h2>
            <ul>
                <li><a href="../../index.html">Home</a></li>
                <li><a href="index.html">Overview</a></li>
                <li><a href="features.html">Features</a></li>
                <li><a href="table-of-contents.html" title="Table of Content">Contents</a></li>
                <li><a href="../examples">Examples</a></li>
            </ul>
            <ul class="search">
                <li>
                    <form class="tpm c9" name="form1" action="../tools/search.php" method="get">
                        <input class="c6 textbox round left" placeholder="Search" type="text" name="q" value="" title="Search User Guide"  />
                        <input class="c2 button round left ltm" type="submit" value="Go" />
                    </form>
                </li>
            </ul>

        </div>
        <hr class="space"/>
        <div class="master-content-wrapper">
            <div class="container prepend-top c48 master-content"><div class="container c45">

    <h2 class="class-name">Class RaxanDataSanitizer</h2>

    <a name="sec-description"></a>
    <div class="rax-box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
                            <span class="disabled">Description</span> |
                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                           
                                </div>
        <div class="rax-box bmm-body">
                        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Provides APIs to filter, sanitizer and format user inputs and file uploads</p>
            <p class="notes">
                Located in <span class="field">/raxan.datasanitizer.php</span> (line <span class="field">13</span>)
            </p>

            
            <pre></pre>

                    </div>
    </div>

    
    
            <a name="sec-var-summary"></a>
        <div class="rax-box bmm">
            <div class="box-title">Variable Summary</span></div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
                                    | 
                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                               
                                            </div>
            <div class="rax-box bmm-body">
                <div class="var-summary">
                                                            <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$badCharacters" title="details" class="var-name">$badCharacters</a>
                    </div>
                                                                                <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$validators" title="details" class="var-name">$validators</a>
                    </div>
                                                                                                                                                                                                                                                                                                                                                    <div class="var-title">
                        <span class="var-type">mixed</span>
                        <a href="#$_charset" title="details" class="var-name">$_charset</a>
                    </div>
                                                                                <div class="var-title">
                        <span class="var-type">mixed</span>
                        <a href="#$_data" title="details" class="var-name">$_data</a>
                    </div>
                                                                                <div class="var-title">
                        <span class="var-type">mixed</span>
                        <a href="#$_date" title="details" class="var-name">$_date</a>
                    </div>
                                                                                <div class="var-title">
                        <span class="var-type">mixed</span>
                        <a href="#$_directInp" title="details" class="var-name">$_directInp</a>
                    </div>
                                                        </div>
            </div>
        </div>
    
            <a name="sec-method-summary"></a>
        <div class="rax-box bmm">
            <div class="box-title">Method Summary</span></div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                     
                    |
                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
            </div>
            <div class="rax-box bmm-body">         
                <div class="method-summary">
                                                                                                    <div class="method-definition">
                        static                             <span class="method-result">null</span>
                                                <a href="#addDataValidator" title="details" class="method-name">addDataValidator</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$pattern</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                            <div class="method-definition">
                                                    <span class="method-result">RaxanDataSanitizer</span>
                                                <a href="#__construct" title="details" class="method-name">__construct</a>
                                                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$array</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$charset</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                                                        <div class="method-definition">
                                                    <span class="method-result">void</span>
                                                <a href="#addValidator" title="details" class="method-name">addValidator</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#alphanumericVal" title="details" class="method-name">alphanumericVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">mixed</span>
                                                <a href="#dateVal" title="details" class="method-name">dateVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#emailVal" title="details" class="method-name">emailVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">void</span>
                                                <a href="#enableDirectInput" title="details" class="method-name">enableDirectInput</a>
                                                    ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$state</span> = <span class="var-default">true</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#escapeVal" title="details" class="method-name">escapeVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#fileContent" title="details" class="method-name">fileContent</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#fileCopy" title="details" class="method-name">fileCopy</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dest</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">int</span>
                                                <a href="#fileCount" title="details" class="method-name">fileCount</a>
                                                ()
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#fileImageResample" title="details" class="method-name">fileImageResample</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$w</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">mixed</span>
                                                <a href="#fileImageSize" title="details" class="method-name">fileImageSize</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#fileMove" title="details" class="method-name">fileMove</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dest</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#fileOrigName" title="details" class="method-name">fileOrigName</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">integer</span>
                                                <a href="#fileSize" title="details" class="method-name">fileSize</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#fileTmpName" title="details" class="method-name">fileTmpName</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#fileType" title="details" class="method-name">fileType</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#fileUploadError" title="details" class="method-name">fileUploadError</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">array</span>
                                                <a href="#filterValues" title="details" class="method-name">filterValues</a>
                                                    ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$keyFields</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">float</span>
                                                <a href="#floatVal" title="details" class="method-name">floatVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#formatDate" title="details" class="method-name">formatDate</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#formatMoney" title="details" class="method-name">formatMoney</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$symbol</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#formatNumber" title="details" class="method-name">formatNumber</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#htmlVal" title="details" class="method-name">htmlVal</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$allowable</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$allowStyle</span> = <span class="var-default">true</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">int</span>
                                                <a href="#intVal" title="details" class="method-name">intVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#isDate" title="details" class="method-name">isDate</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#isEmail" title="details" class="method-name">isEmail</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#isNumeric" title="details" class="method-name">isNumeric</a>
                                                    (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$min</span> = <span class="var-default">null</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$max</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">boolean</span>
                                                <a href="#isUrl" title="details" class="method-name">isUrl</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">int</span>
                                                <a href="#length" title="details" class="method-name">length</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#matchVal" title="details" class="method-name">matchVal</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span> = <span class="var-default">'/[a-zA-Z0-9-.]/'</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result"><a href="RaxanDataSanitizer.html">RaxanDataSanitizer</a></span>
                                                <a href="#setDataArray" title="details" class="method-name">setDataArray</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$array</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#textVal" title="details" class="method-name">textVal</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">null</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">int</span>
                                                <a href="#timestampVal" title="details" class="method-name">timestampVal</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">string</span>
                                                <a href="#urlVal" title="details" class="method-name">urlVal</a>
                                                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$encoded</span> = <span class="var-default">false</span>])
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">mixed</span>
                                                <a href="#value" title="details" class="method-name">value</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">void</span>
                                                <a href="#__call" title="details" class="method-name">__call</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">String</span>
                                                <a href="#__get" title="details" class="method-name">__get</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
                                            </div>
                                                                                <div class="method-definition">
                                                    <span class="method-result">String</span>
                                                <a href="#__set" title="details" class="method-name">__set</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
                                            </div>
                                            </div>
            </div>
        </div>      
    
            <a name="sec-vars"></a>
        <div class="rax-box bmm">
            <div class="box-title">Variables</div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
                           

                                                    | 
                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                               
                            </div>
            <div class="rax-box bmm-body">
                <a name="var$badCharacters" id="$badCharacters"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$badCharacters</span>
             = <span class="var-default">array(&quot;\r&quot;,&quot;\n&quot;,&quot;\t&quot;,&quot;\x00&quot;,&quot;\x1a&quot;)</span>            (line <span class="line-number">16</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$validators" id="$validators"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$validators</span>
             = <span class="var-default">array()</span>            (line <span class="line-number">15</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$_charset" id="$_charset"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">mixed</span>
            <span class="var-name">$_charset</span>
                        (line <span class="line-number">21</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$_data" id="$_data"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">mixed</span>
            <span class="var-name">$_data</span>
                        (line <span class="line-number">18</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$_date" id="$_date"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">mixed</span>
            <span class="var-name">$_date</span>
                        (line <span class="line-number">19</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$_directInp" id="$_directInp"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">mixed</span>
            <span class="var-name">$_directInp</span>
                        (line <span class="line-number">20</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
                           
            </div>
        </div>
    
            <a name="sec-methods"></a>
        <div class="rax-box bmm">
            <div class="box-title">Methods</div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
                           
            </div>
            <div class="rax-box bmm-body">
                <a name='method_detail'></a>
<a name="methodaddDataValidator" id="addDataValidator"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">static addDataValidator</span> (line <span class="line-number">598</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a custom data validator using regex patterns or callback function</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        static <span class="method-result">null</span>
        <span class="method-name">
            addDataValidator
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$pattern</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">mixed</span>
                <span class="var-name">$pattern</span><span class="var-description">: Optional. Regex pattern or a callback function</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$name</span>            </li>
                </ul>
        
            
    </div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">Constructor __construct</span> (line <span class="line-number">24</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">RaxanDataSanitizer</span>
        <span class="method-name">
            __construct
        </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$array</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$charset</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$array</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$charset</span>            </li>
                </ul>
        
            
    </div>
<a name="methodaddValidator" id="addValidator"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">addValidator</span> (line <span class="line-number">72</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a custom data validator using regex patterns or callback function</p>
<p class="description"><p>Used as a wrapper to the RaxanDataSanitizer::addDataValidator() static method</p></p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">void</span>
        <span class="method-name">
            addValidator
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$name</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$pattern</span>            </li>
                </ul>
        
            
    </div>
<a name="methodalphanumericVal" id="alphanumericVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">alphanumericVal</span> (line <span class="line-number">80</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an alphanumeric value for the specified field name</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of alphanumeric values will be returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            alphanumericVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methoddateVal" id="dateVal"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">dateVal</span> (line <span class="line-number">94</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a date value for the specified field name</p>
    <ul class="tags">
                <li><span class="field">return:</span> Returns a date/time string value based on the $format parameter or null if value is not a valid date.  If input is an array then an array of date values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">mixed</span>
        <span class="method-name">
            dateVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$format</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodemailVal" id="emailVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">emailVal</span> (line <span class="line-number">113</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns sanitized email address for the selected field</p>
    <ul class="tags">
                <li><span class="field">return:</span> Returns sanitized email address or an empty string if input value is not a valid email address. If input is an array then an array of email values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            emailVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodenableDirectInput" id="enableDirectInput"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">enableDirectInput</span> (line <span class="line-number">105</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enables direct data input. This will allow values to be passed directly to validator functions.</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
                <li><span class="field">example:</span> example not found</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">void</span>
        <span class="method-name">
            enableDirectInput
        </span>
                    ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$state</span> = <span class="var-default">true</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">boolean</span>
                <span class="var-name">$state</span><span class="var-description">: Defaults to true</span>            </li>
                </ul>
        
            
    </div>
<a name="methodescapeVal" id="escapeVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">escapeVal</span> (line <span class="line-number">126</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns text with special xml/html characters encoded for the selected field</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of escaped values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            escapeVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileContent" id="fileContent"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileContent</span> (line <span class="line-number">140</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the content of an uploaded file based on the selected field name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            fileContent
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileCopy" id="fileCopy"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">fileCopy</span> (line <span class="line-number">151</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Copies an uploaded files (based on the selected field name) to the specified destination.</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            fileCopy
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dest</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$dest</span><span class="var-description">: Destination path and file name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileCount" id="fileCount"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileCount</span> (line <span class="line-number">161</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a total number of file uploaded</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">int</span>
        <span class="method-name">
            fileCount
        </span>
                ()
            </div>
    
        
            
    </div>
<a name="methodfileImageResample" id="fileImageResample"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">fileImageResample</span> (line <span class="line-number">182</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Resamples (convert/resize) the uploaded image. You can specify a new width, height and type</p>
    <ul class="tags">
                <li><span class="field">see:</span> <a href="Raxan.html#methodimageResample">Raxan::imageResample()</a></li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            fileImageResample
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$w</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$w</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$h</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$type</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileImageSize" id="fileImageSize"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileImageSize</span> (line <span class="line-number">170</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array containing the width, height and type for the uploaded image file</p>
    <ul class="tags">
                <li><span class="field">return:</span> Array or null on error</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">mixed</span>
        <span class="method-name">
            fileImageSize
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileMove" id="fileMove"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">fileMove</span> (line <span class="line-number">194</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moves an uploaded files (based on the selected field name) to the specified destination.</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            fileMove
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dest</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$dest</span><span class="var-description">: Destination path and file name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileOrigName" id="fileOrigName"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileOrigName</span> (line <span class="line-number">206</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the original name of the uploaded file based on the selected field name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            fileOrigName
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileSize" id="fileSize"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">fileSize</span> (line <span class="line-number">216</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the size of the uploaded file based on the selected field name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">integer</span>
        <span class="method-name">
            fileSize
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileTmpName" id="fileTmpName"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileTmpName</span> (line <span class="line-number">243</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the temporary file name and path of the uploaded file based on the selected field name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            fileTmpName
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileType" id="fileType"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">fileType</span> (line <span class="line-number">225</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the file type (as reported by browser) of an uploaded file based on the selected field name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            fileType
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfileUploadError" id="fileUploadError"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">fileUploadError</span> (line <span class="line-number">234</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the file upload error code for uploaded file</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            fileUploadError
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$fld</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$fld</span><span class="var-description">: Form element field name</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfilterValues" id="filterValues"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">filterValues</span> (line <span class="line-number">252</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns associative array of filtered/sanitized values</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">array</span>
        <span class="method-name">
            filterValues
        </span>
                    ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$keyFields</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">mixed</span>
                <span class="var-name">$keyFields</span><span class="var-description">: Optional. Comma (,) delimitted key/field names or associative array of field names and filter type. Default to all keys/fields with textVal filter applied</span>            </li>
                </ul>
        
            
    </div>
<a name="methodfloatVal" id="floatVal"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">floatVal</span> (line <span class="line-number">284</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts input value/key to a float value</p>
    <ul class="tags">
                <li><span class="field">return:</span> Returns float if value is numeric or null if there was an error. If input is an array then an array of float values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">float</span>
        <span class="method-name">
            floatVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$decimal</span>            </li>
                </ul>
        
            
    </div>
<a name="methodformatDate" id="formatDate"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">formatDate</span> (line <span class="line-number">303</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns formated date value</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of formated date values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            formatDate
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$format</span><span class="var-description">: Date format</span>            </li>
                </ul>
        
            
    </div>
<a name="methodformatMoney" id="formatMoney"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">formatMoney</span> (line <span class="line-number">346</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns formatted money value based on locale settings</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of formated values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            formatMoney
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$symbol</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">int</span>
                <span class="var-name">$decimal</span><span class="var-description">: Optional. Total number of decimal places to return</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$symbol</span><span class="var-description">: Optional. Currency symbol</span>            </li>
                </ul>
        
            
    </div>
<a name="methodformatNumber" id="formatNumber"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">formatNumber</span> (line <span class="line-number">373</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns formatted number value based on locale settings</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of formatted numeric values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            formatNumber
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">int</span>
                <span class="var-name">$decimal</span><span class="var-description">: Optional. Total number of decimal places to return</span>            </li>
                </ul>
        
            
    </div>
<a name="methodhtmlVal" id="htmlVal"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">htmlVal</span> (line <span class="line-number">391</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sanitized html by removing javascript tags and inline events</p>
    <ul class="tags">
                <li><span class="field">return:</span> If input is an array then an array of html values is returned</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            htmlVal
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$allowable</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$allowStyle</span> = <span class="var-default">true</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$allowable</span><span class="var-description">: Optional. Allowable html tags. Example &lt;p&gt;&lt;a&gt;</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$allowStyle</span><span class="var-description">: Optional. Allow css styles inside html.  Defaults to true</span>            </li>
                </ul>
        
            
    </div>
<a name="methodintVal" id="intVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">intVal</span> (line <span class="line-number">424</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts input value/key to an integer value</p>
    <ul class="tags">
                <li><span class="field">return:</span> Returns interger if value is numeric or null if there was an error</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">int</span>
        <span class="method-name">
            intVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodisDate" id="isDate"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">isDate</span> (line <span class="line-number">439</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the selected field contains a valid date</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            isDate
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$format</span><span class="var-description">: Optional date input format. Accepts the same format as formatDate()</span>            </li>
                </ul>
        
            
    </div>
<a name="methodisEmail" id="isEmail"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">isEmail</span> (line <span class="line-number">454</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the selected field contains a valid email address</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            isEmail
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodisNumeric" id="isNumeric"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">isNumeric</span> (line <span class="line-number">468</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the selected field is numeric</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            isNumeric
        </span>
                    (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$min</span> = <span class="var-default">null</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$max</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">mixed</span>
                <span class="var-name">$key</span><span class="var-description">: Key field name or value</span>            </li>
                    <li>
                <span class="var-type">float</span>
                <span class="var-name">$min</span><span class="var-description">: Optional. Minimum value</span>            </li>
                    <li>
                <span class="var-type">float</span>
                <span class="var-name">$max</span><span class="var-description">: Optional. Maximum value</span>            </li>
                </ul>
        
            
    </div>
<a name="methodisUrl" id="isUrl"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">isUrl</span> (line <span class="line-number">478</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the selected field contains a valid url</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">boolean</span>
        <span class="method-name">
            isUrl
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodlength" id="length"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">length</span> (line <span class="line-number">494</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the length of the speicifed field value</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">int</span>
        <span class="method-name">
            length
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodmatchVal" id="matchVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">matchVal</span> (line <span class="line-number">504</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns matched characters</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            matchVal
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span> = <span class="var-default">'/[a-zA-Z0-9-.]/'</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$pattern</span><span class="var-description">: Optional Regex pattern. Defaults to /[a-zA-Z0-9-.]/</span>            </li>
                </ul>
        
            
    </div>
<a name="methodsetDataArray" id="setDataArray"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">setDataArray</span> (line <span class="line-number">517</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the array source for the sanitizer</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result"><a href="RaxanDataSanitizer.html">RaxanDataSanitizer</a></span>
        <span class="method-name">
            setDataArray
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$array</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$array</span>            </li>
                </ul>
        
            
    </div>
<a name="methodtextVal" id="textVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">textVal</span> (line <span class="line-number">528</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove html tags from input values</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            textVal
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">null</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">int</span>
                <span class="var-name">$maxlength</span><span class="var-description">: Optional. Length of text value to be returned</span>            </li>
                </ul>
        
            
    </div>
<a name="methodtimestampVal" id="timestampVal"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">timestampVal</span> (line <span class="line-number">545</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts input value/key to a valid timestamp</p>
    <ul class="tags">
                <li><span class="field">return:</span> Returns timestamp if value is a valid datetime string or null if there was an error</li>
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">int</span>
        <span class="method-name">
            timestampVal
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="methodurlVal" id="urlVal"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">urlVal</span> (line <span class="line-number">566</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns sanitized url for the selected field</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">string</span>
        <span class="method-name">
            urlVal
        </span>
                    (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$encoded</span> = <span class="var-default">false</span>])
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type">string</span>
                <span class="var-name">$key</span><span class="var-description">: Key name or input value (direct input must be enabled)</span>            </li>
                    <li>
                <span class="var-type">boolean</span>
                <span class="var-name">$encoded</span><span class="var-description">: Optional. Encode url string. Defaults to false</span>            </li>
                </ul>
        
            
    </div>
<a name="methodvalue" id="value"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">value</span> (line <span class="line-number">583</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a value  based on the specified key</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">mixed</span>
        <span class="method-name">
            value
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$key</span>            </li>
                </ul>
        
            
    </div>
<a name="method__call" id="__call"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">__call</span> (line <span class="line-number">30</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">void</span>
        <span class="method-name">
            __call
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$name</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$args</span>            </li>
                </ul>
        
            
    </div>
<a name="method__get" id="__get"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">__get</span> (line <span class="line-number">53</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the sanitized text for the specified key. All html charcters will be removed.</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">String</span>
        <span class="method-name">
            __get
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$name</span>            </li>
                </ul>
        
            
    </div>
<a name="method__set" id="__set"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">__set</span> (line <span class="line-number">64</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the value for a key to be sanitized or formatted.</p>
<p class="description"><p>Example:  $format-&gt;keyName = 'Mary Jane<br />';  echo $format-&gt;textVal('keyName');</p></p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">String</span>
        <span class="method-name">
            __set
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$name</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$value</span>            </li>
                </ul>
        
            
    </div>
                           
            </div>
        </div>
    
    </div>
</div>
            
            <div id="footer" class="container c48 rax-active-pal round rax-glossy">
                <ul class="clearfix">
                    <li><a href="index.html">Overview</a></li>
                    <li><a href="features.html">Features</a></li>
                    <li><a href="new-features.html">What's new</a></li>
                    <li><a href="table-of-contents.html" title="Table of Content">Contents</a></li>
                    <li><a href="../examples">Examples</a></li>
                </ul>
            </div>
        </div>
    </div>
</body>

</html>

